<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Alfar Engine: AlfarEngine.Components.AComponent Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Alfar Engine
   
   </div>
   <div id="projectbrief">A little 2D engine managing a scene</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespace_alfar_engine.html">AlfarEngine</a>      </li>
      <li class="navelem"><a class="el" href="namespace_alfar_engine_1_1_components.html">Components</a>      </li>
      <li class="navelem"><a class="el" href="class_alfar_engine_1_1_components_1_1_a_component.html">AComponent</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">AlfarEngine.Components.AComponent Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="AlfarEngine::Components::AComponent" -->
<p>Abstract class that define a "Component", a specification of an object.  
 <a href="class_alfar_engine_1_1_components_1_1_a_component.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for AlfarEngine.Components.AComponent:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_alfar_engine_1_1_components_1_1_a_component.png" usemap="#AlfarEngine.Components.AComponent_map" alt=""/>
  <map id="AlfarEngine.Components.AComponent_map" name="AlfarEngine.Components.AComponent_map">
<area href="class_alfar_engine_1_1_components_1_1_camera.html" alt="AlfarEngine.Components.Camera" shape="rect" coords="0,56,241,80"/>
<area href="class_alfar_engine_1_1_components_1_1_collider.html" title="Add a Collider to this GameObject. A Collider will detect collision with other collider in the scene..." alt="AlfarEngine.Components.Collider" shape="rect" coords="251,56,492,80"/>
<area href="class_alfar_engine_1_1_components_1_1_light.html" alt="AlfarEngine.Components.Light" shape="rect" coords="502,56,743,80"/>
<area href="class_alfar_engine_1_1_components_1_1_sprite.html" alt="AlfarEngine.Components.Sprite" shape="rect" coords="753,56,994,80"/>
<area href="class_alfar_engine_1_1_components_1_1_spot_light.html" alt="AlfarEngine.Components.SpotLight" shape="rect" coords="502,112,743,136"/>
<area href="class_alfar_engine_1_1_components_1_1_animated_sprite.html" alt="AlfarEngine.Components.AnimatedSprite" shape="rect" coords="753,112,994,136"/>
</map>
 </div></div>

<p><a href="class_alfar_engine_1_1_components_1_1_a_component-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a500e3fdb9dd984424f32d24f3f42b979"></a><!-- doxytag: member="AlfarEngine::Components::AComponent::AComponent" ref="a500e3fdb9dd984424f32d24f3f42b979" args="(GameObject pOwner)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>AComponent</b> (<a class="el" href="class_alfar_engine_1_1_game_object.html">GameObject</a> pOwner)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_components_1_1_a_component.html#ad600a3290e0db6305428786f5e3e2015">Update</a> (GameTime pTime)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this components (override to add specific behaviour)  <a href="#ad600a3290e0db6305428786f5e3e2015"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_components_1_1_a_component.html#a72b092041f8c96a7a0d8eba5bc376827">Draw</a> (GameTime pTime)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the engine Draw the component. Override to specify. This give a base color of white (no teint)  <a href="#a72b092041f8c96a7a0d8eba5bc376827"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_components_1_1_a_component.html#aaa010d944163f806c6f5c2c6528a0646">Draw</a> (GameTime pTime, Color pColor)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the engine Draw the component. Override to specify.  <a href="#aaa010d944163f806c6f5c2c6528a0646"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abca814e3d7f626920cf65df2b03ab9d9"></a><!-- doxytag: member="AlfarEngine::Components::AComponent::mOwner" ref="abca814e3d7f626920cf65df2b03ab9d9" args="" -->
<a class="el" href="class_alfar_engine_1_1_game_object.html">GameObject</a>&#160;</td><td class="memItemRight" valign="bottom"><b>mOwner</b></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_alfar_engine_1_1_game_object.html">GameObject</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_components_1_1_a_component.html#a4f7c11e0a98985a45c9bde9f9424e0b5">owner</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The object on which this component is attached.  <a href="#a4f7c11e0a98985a45c9bde9f9424e0b5"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class that define a "Component", a specification of an object. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a72b092041f8c96a7a0d8eba5bc376827"></a><!-- doxytag: member="AlfarEngine::Components::AComponent::Draw" ref="a72b092041f8c96a7a0d8eba5bc376827" args="(GameTime pTime)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AlfarEngine.Components.AComponent.Draw </td>
          <td>(</td>
          <td class="paramtype">GameTime&#160;</td>
          <td class="paramname"><em>pTime</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called when the engine Draw the component. Override to specify. This give a base color of white (no teint) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pTime</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aaa010d944163f806c6f5c2c6528a0646"></a><!-- doxytag: member="AlfarEngine::Components::AComponent::Draw" ref="aaa010d944163f806c6f5c2c6528a0646" args="(GameTime pTime, Color pColor)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AlfarEngine.Components.AComponent.Draw </td>
          <td>(</td>
          <td class="paramtype">GameTime&#160;</td>
          <td class="paramname"><em>pTime</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Color&#160;</td>
          <td class="paramname"><em>pColor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called when the engine Draw the component. Override to specify. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pTime</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="class_alfar_engine_1_1_components_1_1_sprite.html#a466039b7ff2ef817ca1bf769e91252b1">AlfarEngine.Components.Sprite</a>.</p>

</div>
</div>
<a class="anchor" id="ad600a3290e0db6305428786f5e3e2015"></a><!-- doxytag: member="AlfarEngine::Components::AComponent::Update" ref="ad600a3290e0db6305428786f5e3e2015" args="(GameTime pTime)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AlfarEngine.Components.AComponent.Update </td>
          <td>(</td>
          <td class="paramtype">GameTime&#160;</td>
          <td class="paramname"><em>pTime</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Update this components (override to add specific behaviour) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pTime</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="class_alfar_engine_1_1_components_1_1_collider.html#a18e0064b100dbf5a29ec675de408af26">AlfarEngine.Components.Collider</a>, and <a class="el" href="class_alfar_engine_1_1_components_1_1_light.html#a9e9a51fbe2b7984a1dae6125870a4995">AlfarEngine.Components.Light</a>.</p>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a4f7c11e0a98985a45c9bde9f9424e0b5"></a><!-- doxytag: member="AlfarEngine::Components::AComponent::owner" ref="a4f7c11e0a98985a45c9bde9f9424e0b5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_alfar_engine_1_1_game_object.html">GameObject</a> AlfarEngine.Components.AComponent.owner<code> [get]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The object on which this component is attached. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>E:/XNA/alfarEngine/AlfarEngine/Components/AComponent.cs</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 16 2012 09:38:38 for Alfar Engine by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
